PATHMac OS 8 Developer Documentation > Networking and Communications > AppleShare >

User Authentication Modules

Server User Authentication Modules

This chapter describes the AppleTalk Filing Protocol (AFP) server user authentication module (UAM) interface. A server UAM is a Code Fragment Manager (CFM) library loaded by the AppleShare Registry at system startup in order to perform user authentication.

Server UAMs must meet the following requirements:

Have a creator code of 'asda' and type code of 'asru' .
Export the following symbols:



 
    unsigned long UAMVersion = 0;

    unsigned long UAMFlags = 0;

    Str16 *UAMName = "\p<unique-uam-name>";     // The protocol name 

                                                // of the UAM

Reside in a folder named "AppleShare IP UAM" in the Extensions folder inside the System Folder.
Implement and export a UAMAuthenticate routine that, at minimum authenticates the user's connection request. The UAMAuthenticate routine can optionally perform these additional tasks:

Change the user's password
Change to a specified user ID for a session
Create a new user

In addition to implementing a UAMAuthenticate routine, server UAMs may

provide an _Initialize Code Fragment Manager routine that initializes the server UAM
provide a UAMInitialize routine that initializes the server UAM
provide an _Terminate Code Fragment Manager routine that prepares the server UAM for shutdown

For additional information about these routines, see Application-Defined Routines .

The server UAM programming interface consists of the following functions:

UAMChangeUID , which changes the user ID for a session
UAMCreateObject , which adds a user to the Users & Groups Data File
UAMGetAttribute , which gets the value of a user attribute
UAMGetAttributeID , which gets the value of a user attribute by its object ID
UAMSetAttribute , which sets the value of a user attribute
UAMSetAttributeID , which sets the value of a user attribute by specifying its object ID
UAMGetThreadID , which gets the thread ID of the current thread
UAMSleep , which yields time
UAMWakeup , which wakes up a thread after yielding time

For additional information about these routines, see Server UAM Functions later in this chapter.

Note

UAMs are loaded when the computer starts up. Changes to the files in the AppleShare IP UAM folder do not take effect until the next time the computer restarts.